home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / rats200.zip / RATS.DOC < prev    next >
Text File  |  1993-03-01  |  40KB  |  1,081 lines
  1.  
  2.  
  3.                                        - RATS -
  4.                              RemoteAccess TimeBank System
  5.                                     Version  2.00
  6.                                  Copyright 1990-1993
  7.                                  Motor City Software
  8.  
  9.                                  All Rights Reserved
  10.  
  11.                             Documentation by Rick Luquette
  12.                                              Rod Hancock
  13.  
  14.           -----------------------------------------------------------------
  15.                Introduction
  16.           -----------------------------------------------------------------
  17.  
  18.  
  19.                A Time  Bank is  a  door program  that allows  BBS users  to
  20.           deposit, withdraw, borrow and repay online time and file transfer
  21.           credits.
  22.  
  23.                The RemoteAccess TimeBank System  (better known as RATS) for
  24.           RemoteAccess and QuickBBS has  many features for the user  and is
  25.           easy to set up and use for the sysop.
  26.  
  27.                Here are just a few of RATS' features:
  28.  
  29.                Interfaces with programs that automatically  deposit minutes
  30.                in user accounts via an external support file.
  31.  
  32.                Works  with  RemoteAccess  versions  1.10  through  2.00 and
  33.                QuickBBS 2.75 through 2.76.
  34.  
  35.                Includes a separate data file maintenance utility.
  36.  
  37.                Provides hot-key support.  If the user is  familiar with the
  38.                commands, the current screen  output can be interrupted when
  39.                a command key is pressed.
  40.  
  41.                Uses a graphic transaction screen and Sysop-definable colors
  42.                for most fields and prompts. The main transaction screen  is
  43.                fully configurable. You simply draw your own screen with any
  44.                ANSI Editor.
  45.  
  46.                Automatically  detects a logon by  the sysop or  a named co-
  47.                sysop, allowing access to sysop functions.
  48.  
  49.                Allows  the  sysop to  define  values  for maximum  deposit,
  50.                withdrawal,  and balance  for  both time  and file  transfer
  51.                credits.
  52.  
  53.                Allows users  to purchase file transfer  credits with online
  54.                time, and to borrow time or transfer credits from the bank.
  55.  
  56.                Includes full multi-node support, and much much more.
  57.  
  58.  
  59.  
  60.                                           1
  61.  
  62.  
  63.  
  64.  
  65.  
  66.           -----------------------------------------------------------------
  67.                Table of Contents
  68.           -----------------------------------------------------------------
  69.  
  70.  
  71.           Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   1
  72.  
  73.           Table of Contents . . . . . . . . . . . . . . . . . . . . . .   2
  74.  
  75.           Licensing Information . . . . . . . . . . . . . . . . . . . .   3
  76.  
  77.           Distribution Files  . . . . . . . . . . . . . . . . . . . . .   4
  78.  
  79.           Getting Started -- Installation . . . . . . . . . . . . . . .   4
  80.  
  81.           RATSCFG.EXE
  82.  
  83.               Global  . . . . . . . . . . . . . . . . . . . . . . . . .   5
  84.  
  85.               Limits  . . . . . . . . . . . . . . . . . . . . . . . . .   6
  86.  
  87.               Hours . . . . . . . . . . . . . . . . . . . . . . . . . .   8
  88.  
  89.               Robbery . . . . . . . . . . . . . . . . . . . . . . . . .   9
  90.  
  91.               Lottery . . . . . . . . . . . . . . . . . . . . . . . . .  10
  92.  
  93.               Maintenance . . . . . . . . . . . . . . . . . . . . . . .  11
  94.  
  95.           Running The Door  . . . . . . . . . . . . . . . . . . . . . .  13
  96.  
  97.           Performing Nightly Maintenance (RMU.EXE)  . . . . . . . . . .  14
  98.  
  99.           Loan Repayment System (RATPAY.EXE)  . . . . . . . . . . . . .  15
  100.  
  101.           Creating Your Own ANSI Screens  . . . . . . . . . . . . . . .  16
  102.  
  103.           A Final Note  . . . . . . . . . . . . . . . . . . . . . . . .  18
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.                                           2
  123.  
  124.  
  125.  
  126.  
  127.  
  128.           -----------------------------------------------------------------
  129.                Licensing Information
  130.           -----------------------------------------------------------------
  131.  
  132.  
  133.                Motor City doors are  commercial programs marketed under the
  134.           "User  Supported"  or "Shareware"  concept.  You  are allowed  to
  135.           install  this  program on  Your  system  and evaluate  it  before
  136.           deciding whether to purchase a license to continue using it. This
  137.           program is not public domain or freeware. If you use this program
  138.           for more  than 30  days after  successful  installation, you  are
  139.           legally required to register it or remove all working copies from
  140.           your system.
  141.  
  142.                The  User Supported or  Shareware concept works  only if you
  143.           and  your  fellow sysops  support it.  If  you find  this program
  144.           useful, you  can register it for only  $15.00 in U.S. funds. This
  145.           will help offset the development costs, and encourage us to write
  146.           other programs  that might  be useful to  you. After all,  no one
  147.           likes to work for nothing! A Registration Form is included in the
  148.           RATS distribution archive.
  149.  
  150.                RATS is  Copyrighted 1990,91,92 by Motor  City Software, ALL
  151.           RIGHTS  RESERVED. You may copy this program and documentation for
  152.           backup purposes. You also may copy and share UNMODIFIED copies of
  153.           the original  program archive.  The copyright notice  must remain
  154.           attached to all copies.
  155.  
  156.                You  may not sell Motor City Software products for a fee, or
  157.           distribute it  along with other products  without written permis-
  158.           sion of  Motor City Software,  nor may  you modify or  remove the
  159.           Copyright  Notice  from the  program  or  the documentation.  BBS
  160.           operators  who charge for access to their systems are exempt from
  161.           this provision as long  as no additional payment is  required for
  162.           access to Motor City Software products beyond basic file access.
  163.  
  164.                All  Motor City  Software  products are  extensively  tested
  165.           before being  publicly released, but  as with any  software, bugs
  166.           may still occur. Motor City Software products are provided as is,
  167.           and neither Motor City Software nor any BBS operator distributing
  168.           this  software is responsible for any  damage incurred during the
  169.           operation of the RATS program. You  are advised to test all Motor
  170.           City  Software products thoroughly on  a backup copy  of your BBS
  171.           before putting them online.
  172.  
  173.                Comments, suggestions  and bug  reports are welcome.  If you
  174.           have any, you  may call  one of the  Motor City Software  Support
  175.           Systems listed in SUPPORT.DOC  and leave a message to  the Sysop.
  176.           If you're reporting a bug, please give as much detail as possible
  177.           about the problem you are having, your system  configuration, and
  178.           if  you  would be  willing to  test  possible corrections  to the
  179.           problem.
  180.  
  181.  
  182.                                           3
  183.  
  184.  
  185.  
  186.  
  187.  
  188.           -----------------------------------------------------------------
  189.                Distribution Files
  190.           -----------------------------------------------------------------
  191.  
  192.                The original program is  distributed in archive format using
  193.           the ARJ archiving format.  Additions or deletions are prohibited.
  194.           Make sure the Arj Security Envelope is intact.
  195.           The distribution archive contains the following files:
  196.  
  197.                     RATSCFG.EXE    The RATS configuration program
  198.                     RATS.EXE       The program executable
  199.                     RATS.DOC       This documentation file
  200.                     RATPAY.EXE     Loan Repayment Maintenance Utility
  201.                     RMU.EXE        RATS maintenance utility
  202.  
  203.                     RATS.HLP       The program help file
  204.                     RATS.NEW       Program revision history (read this!!)
  205.                     REGISTER.ARJ   Registration forms
  206.                     SUPPORT.DOC    Location of Support Systems
  207.  
  208.           -----------------------------------------------------------------
  209.                Getting Started -- Installation
  210.           -----------------------------------------------------------------
  211.  
  212.  
  213.                              Upgrades from prior versions
  214.  
  215.                The  current version of RATS is compatible with the RATS.DAT
  216.           file format  introduced in version 1.20.  Users of prior versions
  217.           will have to install version 2.00 as though this were  an initial
  218.           installation. Read Upgrade.Inf file if you are upgrading!
  219.  
  220.  
  221.                                 Initial Installations
  222.  
  223.                Unpack the distribution archive into the directory where you
  224.           want to keep your RATS.DAT file. RATS can be run in any subdirec-
  225.           tory  as  long as  paths are  setup  properly in  RATSCFG.EXE. We
  226.           recommend creating a  RATS subdirectory off your  main BBS direc-
  227.           tory, or where your other DOORS are kept.
  228.  
  229.                Run the RATSCFG.EXE program to create the RATS configuration
  230.           file.
  231.  
  232.                After  starting RATSCFG,  you'll  see a  list of  selections
  233.           across the screen. As  you make your selections, menus  will drop
  234.           down and present you with various choices.
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.                                           4
  243.  
  244.                                      RATSCFG.EXE
  245.  
  246.                                      INFORMATION
  247.  
  248.                About RATS : Copyright Notice For RATS.
  249.  
  250.                Registration: How to register RATS.
  251.  
  252.  
  253.                                       GLOBAL
  254.  
  255.                Pick Specific Node :
  256.  
  257.                RATS  by default,  only keeps  ONE configuration file called
  258.           GLOBAL.CFG   Some sysops like to set different limits etc on some
  259.           nodes,  so we have  allowed you to create a  Node Specific Config
  260.           file  as well. For Example, when node 4 loads RATS, it will first
  261.           look for  a  GLOBAL04.CFG,  and if not found,  loads the  default
  262.           GLOBAL.CFG   Normally you  won't use this  option.  If this is an
  263.           initial installation,  or if you're setting up a new node,  press
  264.           <ESC> and then  enter the  node number  you want  to configure.
  265.  
  266.                Paths/Filenames:
  267.  
  268.                RATS needs to know where to look for certain files, as well
  269.           as needing some general information. You may press  F1 at any of
  270.           the input fields on this screen for online help.
  271.  
  272.                THEBANK Path :  Some  other  doors   create  a  file  called
  273.           THEBANK.EXT to generate automatic  deposits and withdrawals  from
  274.           RATS. This file is usually stored in your main BBS directory. See
  275.           the documentation  for the  program that creates  THEBANK.EXT for
  276.           more information.
  277.  
  278.                Semaphore Dir:  If you're  running Remote Access,  RATS will
  279.           look  for and  read  semaphore files  in this directory.  See the
  280.           RA  manual for more information.  RATS will  honor a  forced exit
  281.           via semaphore if running under RemoteAccess.
  282.  
  283.                RMU Log Name : This is the full path and filename you want
  284.           RMU to log its activities to.
  285.  
  286.                Log Style : What style of log file would you like to use.
  287.  
  288.                Log UserStats?: If you choose Yes, RATS will write the users
  289.           time and  KBytes in the bank, and on  hand, to the usage log each
  290.           time the user  enters or exits  the bank. You  might wish to  ac-
  291.           tivate this feature if you are having problems with RATS.
  292.  
  293.                RATS Log Name: RATS  will log all user activity to  the file
  294.           you name here.  If you wish,  you may have it  added to  your BBS
  295.           System Log. Putting a *N anywhere in the path or filename will be
  296.           replaced with a 2 digit node number when the log file is opened.
  297.           You can use this to write to d:\bbs\line*n\bbs.log or
  298.           d:\bbs\rats\rats*n.log
  299.  
  300.  
  301.  
  302.                                           5
  303.  
  304.                Sysop  Name: Enter the name  of the BBS  operator. This will
  305.           most likely be your name.
  306.  
  307.                BBS Name: Enter the name of the BBS.
  308.  
  309.                BBS Type: This is used by RMU to be sure it uses the correct
  310.           USERS.BBS  structures when forcing loan payments.  RATS is  fully
  311.           Compatable with RemoteAccess 2.00
  312.  
  313.                Users.BBS: Path to the users.bbs file. Used by RMU.EXE
  314.  
  315.  
  316.  
  317.  
  318.  
  319.                                      BANK LIMITS
  320.  
  321.                This is  the heart  of RATS.  The limits  you set  here will
  322.           control the usefulness of RATS for your users.
  323.  
  324.                Name Of Bank:  The name you enter here  will be displayed on
  325.           the top line of the  screen whenever a user is in RATS.  Be crea-
  326.           tive!
  327.  
  328.                CoSysop Name: If you allow someone else to help you run your
  329.           BBS (a CoSysop),  enter his or  her name here. Your  cosysop will
  330.           have  access to RATS sysop functions while online within the door
  331.           program.
  332.  
  333.                Minimum Security:  The  minimum  security  level  needed  to
  334.           access  RATS. If a user with  a lower security level enters RATS,
  335.           he/she will be told that he/she cannot use the TimeBank. You  may
  336.           assign any level from 1 through 64,000
  337.  
  338.                Usage Before Deposit: This setting tells RATS how much  time
  339.           a user must  spend on the BBS before being  allowed to access the
  340.           time bank. If  this field is  set to 0, a  user can log  onto the
  341.           BBS, deposit all of his or her available time, and  then log off.
  342.           You can enter a figure from 0 to 30.
  343.  
  344.                Inactivity  Timeout: If  a user  falls asleep,  or otherwise
  345.           becomes  occupied, RATS  will abort  back to  the BBS  after this
  346.           time, which can be set from 2 to 10 minutes.
  347.  
  348.                Time Remaining To Access:  A user who is running out of time
  349.           may  want  to frantically  dash to  the  time bank,  borrowing or
  350.           withdrawing at the last minute. An entry here  forces the user to
  351.           use a  little  advance  planning  rather than  make  last  minute
  352.           decisions. Entries from 1 to 60 minutes are permitted.
  353.  
  354.                Maximum Time Deposit: This  is the MAXIMUM time that  a user
  355.           can deposit  into his/her account in  one day. Entries  from 0 to
  356.           1440 are permitted. An  entry of 0 disables deposits;  while 1440
  357.           minutes equals 24 hours, effectively negating this feature.
  358.  
  359.  
  360.  
  361.  
  362.                                           6
  363.  
  364.  
  365.  
  366.                Maximum Time  Withdraw: A  user with a  high enough  balance
  367.           could  conceivably withdraw enough time to tie up your BBS for an
  368.           entire day. An  entry in this field regulates the amount that can
  369.           be withdrawn  in one day. Entries  from 0 to 1440  are permitted,
  370.           with 0 disabling withdrawals.
  371.  
  372.                Maximum Time Transfer: One of  the more powerful features of
  373.           RATS is the ability of one user to transfer time/bytes to another
  374.           provided both have RATS accounts. This controls the  MAXIMUM time
  375.           a  user may  transfer to  another user.  Entries from  0 to  1440
  376.           minutes are permitted, with 0 disabling transfers.
  377.  
  378.                Maximum  Time Balance: This sets the maximum a user can have
  379.           on  deposit in  his/her  account. Entries  from  0 to  64000  are
  380.           permitted, with 0 allowing a virtually unlimited balance.
  381.  
  382.                Maximum Time Loan: This  setting determines how much  time a
  383.           user is allowed to borrow from the  time bank. If set to 0,  then
  384.           Time loans are disabled. The maximum setting is 1440 minutes.
  385.  
  386.                Maximum K-Byte Loan: This setting determines how many KBytes
  387.           of  file transfer credits  a user is  allowed to  borrow from the
  388.           time bank. If  set to 0,  K-Byte loans are disabled.  The maximum
  389.           setting is 9000K.
  390.  
  391.                (If  Both Time  and  K-Byte loans  are set  to  0, then  the
  392.           <C>redit Department will not show up on the users screen.)
  393.  
  394.                Maximum  K-Byte Deposit:  Sets  the maximum  KBytes of  file
  395.           transfer credits a user  can deposit into his/her account  in one
  396.           day. A setting  of 0  disables deposits; the  maximum setting  is
  397.           32,000K.
  398.  
  399.                Maximum  K-Byte Withdraw:  Sets the  maximum KBytes  of file
  400.           transfer  credits a user may withdraw from his/her account in one
  401.           day. An entry of 0 disables withdrawals; the maximum is 32,000K.
  402.  
  403.                Maximum K-Byte  Transfer: Users may transfer  KBytes of file
  404.           transfer  credits  to one  another, as  long  as both  users have
  405.           accounts in RATS. This  field determines the maximum that  can be
  406.           transferred.  An  entry  of  0 disables  transfers;  the  maximum
  407.           setting is 30,000.
  408.  
  409.                Maximum  K-Byte Balance:  Sets  the maximum  KBytes of  file
  410.           transfer credits  a user is allowed to  have on deposit. An entry
  411.           of 0 makes this field unlimited; the highest limit is 64,000.
  412.  
  413.                Maximum K-Byte  Purchase: RATS allows users  to spend online
  414.           time  from their  balance  to purchase  KBytes  of file  transfer
  415.           credits. A setting of 0 disables purchasing; the maximum is 5000.
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.                                           7
  423.  
  424.                K-Byte Cost in Minutes: If purchasing is allowed, this field
  425.           sets the price in time for each 50 KBytes of file transfer credit
  426.           purchased.  Entries  of  1  to  5000  minutes  per  50 KBytes are
  427.           permitted. NOTE : In Previous  versions of RATS, this was minutes
  428.           per 1K, it is now per 50K!!!
  429.  
  430.                Sysop Overrides Limits?: This will allow the sysop and the
  431.           co-sysop  to be exempt from the limits you impose on your users.
  432.           This will NOT override system events.
  433.  
  434.                RatsCfg Password: This allows you to specify a  password to
  435.           protect access to RatsCfg.  While its not meant  to be  a secure
  436.           way to protect access, it will keep the casual browser (You have
  437.           kids too?) out.
  438.  
  439.                                       BANK HOURS
  440.  
  441.                This  section controls  the hours  during which  sections of
  442.           your bank are "open" to users.
  443.  
  444.                Deposit Time: Start and End times that deposits can be made.
  445.  
  446.                Withdraw Time: Start/End times that withdrawals can be made.
  447.  
  448.                Borrow  Time: Beginning  and  ending time  that  a user  can
  449.           borrow time from the credit department.
  450.  
  451.                Transfer Time:  Beginning and ending  time that  a user  can
  452.           transfer time to another user.
  453.  
  454.                Override Level: Restrictions set above will not apply to any
  455.           user with a security level above this setting.
  456.  
  457.                Loan Flag: This flag  setting is used by RATS  and RATPAY to
  458.           handle the checking and repayment of borrowed time/kbytes.
  459.  
  460.                Bank Loan Interest Rate:  Just like a regular bank,  you can
  461.           charge interest when a  user borrows time or file  transfer cred-
  462.           its.  If you  enter 10, a  user who  borrows 100  minutes will be
  463.           charged a one-time 10 minute interest fee, and will have to repay
  464.           110 minutes. Interest rates of 0 to 100% are permitted.
  465.  
  466.                Min  Payment K: Minimum payment  that a user  must make when
  467.           paying  back file  transfer credits.  This prevents  a user  from
  468.           borrowing 50 megabytes, and paying back 1 K per day.
  469.  
  470.                Min  Payment: Minimum  payment that  a  user must  make when
  471.           paying back borrowed time.
  472.  
  473.                HangUp: Determines whether RATS  will hang up on a  user who
  474.           does not want to make a mandatory payment.
  475.  
  476.                Auto Payments:  No,  it won't make your car payments for you
  477.           but this will  force  RMU.EXE to  deduct  time from a  users  BBS
  478.           account to make his daily minimum payment on  Time and/or  KBytes
  479.           borrowed from the bank.
  480.  
  481.  
  482.                                           8
  483.  
  484.                                       BANK COLORS
  485.  
  486.                Colors: Allows you to customize RATS display colors. Keep in
  487.           mind  that some  color combinations  are invisible  to monochrome
  488.           callers. Also if you design your own main screen, you must ensure
  489.           that the  colors you  enter here are the  same colors you used to
  490.           draw your screen.
  491.  
  492.  
  493.                                       ROBBERY INFORMATION
  494.  
  495.           NOTE : These Options Are Configurable. If you DON'T want to allow
  496.                  users to access them, just run them off.
  497.  
  498.           With  RATS V2.0  we have added an Option to ROB the Bank. You may
  499.           configure the  COST in Minutes,  and or  KBytes that is withdrawn
  500.           from the users account when he tries to  ROB the  Bank.  You also
  501.           configure the  odds of success,  and the amount the user receives
  502.           if he/she is successful.
  503.  
  504.            We  have also  added  an option  to  ROB another  User.  You may
  505.            configure the  COST in minutes, and or  KBytes that is withdrawn
  506.            from the  users account when he tries to ROB  another User.  You
  507.            also configure the  odds of success.  If the user is successful,
  508.            then he will take 50% of the other users bank balance, both time
  509.            and KBytes.  If the user is  NOT successful in robbing the other
  510.            user,  then the  other  user will  have the  COST of the robbery
  511.            attempt added to his/her account. This way, you don't always get
  512.            robbed and lose, now you can actually benifit from people trying
  513.            to rob you.
  514.  
  515.            When a user enters RATS for the first time, or they have not yet
  516.            been asked,  RATS will ask them if they wish to be excluded from
  517.            this feature. If a user  elects to be  excluded,  then that user
  518.            may NOT rob any other users, and no other users may rob him/her.
  519.            The user cannot change this option, or they would simply turn it
  520.            off, rob other players, then turn it on again. If a user changes
  521.            their mind,  they will have to ask  YOU to change it in the user
  522.            editor in RatsCfg.Exe
  523.  
  524.                Allow Users To Rob The Bank : If  No,  then this option will
  525.            not be available to your users from RATS.
  526.  
  527.                Allow Users To Rob Other Users: If No, then this option will
  528.            not be available to your users from RATS.
  529.  
  530.                Maximum Time Allowed To Rob From Bank: This is the amount of
  531.            time a user will steal from the bank if they are successful.
  532.  
  533.                Maximum  KBytes Allowed To Rob From Bank: This is the amount
  534.            of time a user will steal from the bank if they are successful.
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.                                           9
  543.  
  544.  
  545.                Odds Of Successfuly Robbing The Bank:  You  define the  odds
  546.            here. 1 out of every X attempts will be Successful.
  547.  
  548.                Odds Of Successfuly Robbing User: You define the  odds here.
  549.            1 out of every X attempts will be Successful.
  550.  
  551.                Cost Of Robbing Bank In KBytes : How much will it  COST  the
  552.            user in KBytes to attempt Robbing the Bank.
  553.  
  554.                Cost Of Robbing Bank In Minutes : How much will it  COST the
  555.            user in Minutes to attempt Robbing the Bank.
  556.  
  557.                Cost Of Robbing User In KBytes : How much will it  COST  the
  558.            user in KBytes to attempt Robbing another user.
  559.  
  560.                Cost Of Robbing User In Minutes : How much will it  COST the
  561.            user in Minutes to attempt Robbing another user.
  562.  
  563.  
  564.  
  565.                                       LOTTERY INFORMATION
  566.  
  567.            This is another new feature added for RATS V2.00  You can allow,
  568.            or disallow Time and KByte wagering.  If this is disabled,  then
  569.            the Lotter Room option will not be visible on the menu.
  570.  
  571.            QuickPick Lottery You configure the COST of tickets. Tickets can
  572.            be  bought with  Time Or KBytes.  If the user  buys a  QuickPick
  573.            ticket with Time then the prize will be time. You also configure
  574.            the PRIZE amount. To win the quickpick, the user picks a 3 digit
  575.            number,  and the computer also picks a 3 digit number.  123  and
  576.            132 will match ONE number, the 1. Place is important!
  577.  
  578.            Daily Lottery.  You configure the ticket price and the winner is
  579.            picked when RMU is run.  When a user buys a ticket,  it puts his
  580.            name in the DAILY.DAT data file and one of these names is drawn.
  581.            The winner wins 50% of ALL ticket costs for that day. If tickets
  582.            cost 10 minutes and 100Kbytes, and 5 users but tickets with time
  583.            and  5  with KBytes,  then the winner will win 50% of 50 min and
  584.            500K, which is 25 Min and 250K.
  585.  
  586.            The Monthly Lottery is similar to the daily lottery but the draw
  587.            is held on a monthly basis.  This uses the MONTHLY.DAT data file
  588.  
  589.  
  590.                Allow Users to Buy Lottery Tickets : If you say  NO then the
  591.            Lottery option will not be present on the users menu.
  592.  
  593.                QuickPick Lottery Ticket Cost (Min) : The COST in minutes of
  594.            a QuickPick Lottery Ticket.
  595.  
  596.                QuickPick Lottery Ticket Cost (KBytes) : The COST in minutes
  597.            of a QuickPick Lottery Ticket.
  598.  
  599.            Note, the user may decide whether to wager Time or KBytes on the
  600.            QuickPick Lottery.
  601.  
  602.                                           10
  603.  
  604.  
  605.            With the Draws the user must wager whatever you define, in other
  606.            word, if you define the cost as 10 Minutes, and 100 KBytes, then
  607.            the user pays BOTH for a ticket. The following fields are pretty
  608.            self-explanitory.
  609.  
  610.                Daily Draw Lottery Ticket Cost (Min):
  611.  
  612.                Daily Draw Lottery Ticket Cost (KBytes):
  613.  
  614.                Monthly Draw Lottery Ticket Cost (Min):
  615.  
  616.                Monthly Draw Lottery Ticket Cost (KBytes):
  617.  
  618.                Keep Bank Records For  How Many  Days? :  This  is  used  to
  619.            determine how long to keep the BANKBOOK records,  as well as the
  620.            list of past lottery winners.
  621.  
  622.  
  623.  
  624.                                      CUSTOM LOTTERY COLORS
  625.  
  626.                This will allow you to change the colors of the lottery room
  627.            Screen.
  628.  
  629.                                      DEFAULT LOTTERY COLORS
  630.  
  631.                Reset the lottery room colors to the default colors.
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.                                      MAINTENANCE
  640.  
  641.                View  Users: List  all users  who have  an account  in RATS,
  642.           showing  their name,  current Time/KByte  balance, the  last date
  643.           they accessed RATS, and if the user is marked for deletion.
  644.  
  645.                Add User: Allows you to open a user account. You may specify
  646.           the user's name, and the time and KByte balance etc.
  647.  
  648.                Edit Users: Allows  you to  search for, and  edit any  users
  649.           account.
  650.  
  651.                Delete User:  You'll be prompted  for a search  string, then
  652.           asked  if you  want  to delete  matching names.  If the  user was
  653.           already  marked  for deletion,  you'll be  asked  if you  want to
  654.           reverse the deletion, providing the database has not been purged.
  655.  
  656.                Purge Users:  This selection  rewrites the data  files, per-
  657.           manently removing any users marked for deletion. (RMU also purges
  658.           users during nightly maintenance.)
  659.  
  660.  
  661.  
  662.                                           11
  663.  
  664.  
  665.                BankBook Records: Creates  an ASCII file named  BANKBOOK.RPT
  666.           in the  current directory,  listing the transaction  reports. RMU
  667.           will trim this file to the last 7 days transactions.
  668.  
  669.                User Balances: Creates an ASCII file named USERS.RPT in  the
  670.           current directory, listing information about each user's account.
  671.  
  672.  
  673.                                          EXIT
  674.  
  675.                Quit To DOS: Exits RATSCFG.
  676.  
  677.  
  678.  
  679.  
  680.  
  681.  
  682.  
  683.  
  684.  
  685.  
  686.  
  687.  
  688.  
  689.  
  690.  
  691.  
  692.  
  693.  
  694.  
  695.  
  696.  
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.  
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.                                           12
  723.  
  724.  
  725.           -----------------------------------------------------------------
  726.                Running RATS On Your BBS
  727.           -----------------------------------------------------------------
  728.  
  729.  
  730.                Here's a sample type 7 optional data line that you might use
  731.            to run RATS:
  732.  
  733.                          C:\BBS\RATS\RATS.EXE /N*N
  734.  
  735.                The  only parameter accepted on the command line is the node
  736.           number.  RATS no longer needs to run from a batch file. RATS will
  737.           look for the  ExitInfo.BBS  and  Dorinfo1.Def file in the current
  738.           directory,  and its own files in the directory where  RATS.EXE is
  739.           located.
  740.  
  741.                If you're  running a  single line system,  leave off  the /N
  742.           parameter and it will default to Node 1
  743.  
  744.                RATS no longer uses a seperate  configuration file  for each
  745.           node,  so you will find that  adding another  node to your system
  746.           will  NOT  require ANY changes to RATS or its configuration files
  747.           at all.
  748.  
  749.  
  750.  
  751.  
  752.  
  753.  
  754.  
  755.  
  756.  
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.  
  767.  
  768.  
  769.  
  770.  
  771.  
  772.  
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.                                           13
  781.  
  782.           -----------------------------------------------------------------
  783.                Performing Nightly Maintenance (RMU.EXE)
  784.           -----------------------------------------------------------------
  785.  
  786.  
  787.                RMU.EXE  (RATS Maintenance  Utility) is  designed to  be run
  788.           nightly during  your system's maintenance event  to perform these
  789.           functions:
  790.  
  791.           1 -  Deletes users  whose account  balances are zero  minutes and
  792.                zero  kilobytes. To retain an  account in RATS,  a user must
  793.                have at least one minute of time or one kilobyte on account.
  794.                A User will NOT be removed if the have an  outstanding loan.
  795.  
  796.           2 -  Removes users who no longer exist in the USERS.BBS file.
  797.  
  798.           3 -  Sorts all accounts in alphabetical order by last name.
  799.  
  800.           4 -  Trims the BANKBOOK.DAT file so that it contains transactions
  801.                for the number of days you specify in RatsCfg
  802.  
  803.           5 -  Ensures that  there are  no duplicated  records in  the RATS
  804.                database.
  805.  
  806.           6 -  Rebuilds the User Index Files.
  807.  
  808.           7 -  Draws  Daily Lottery Ticket  Winner  from  those who  bought
  809.                tickets on the previous day, then removes those entries from
  810.                the active Ticket file.
  811.  
  812.  
  813.  
  814.  
  815.           8 -  Draws  Daily Lottery Ticket  Winner  from  those who  bought
  816.                tickets during the previous month then removes those entries
  817.                from the active  Ticket file.  This only draws from  tickets
  818.                bought the previous month,  and will  draw a  name the first
  819.                time  its run  in a  new month.  It then removes those names
  820.                from the ticket list,  and in effect,  will not draw another
  821.                winner until the month changes again.
  822.  
  823.           9 - Trims the WINNERS.DAT file so it contains the name of winners
  824.               for the number of days you specified in RatsCfg.
  825.  
  826.          10 - If you have activated Auto Loan Payments then RMU will deduct
  827.               any loan payments due right out of the users.bbs file.
  828.  
  829.  
  830.  
  831.  
  832.                RMU.EXE  requires NO commandline parameters. It reads the
  833.           GLOBAL.CFG file from the directory containing RMU.EXE and gets
  834.           all the info it needs from there.
  835.  
  836.  
  837.  
  838.  
  839.  
  840.                                           14
  841.  
  842.  
  843.           -----------------------------------------------------------------
  844.                Loan Repayment System (RATPAY.EXE)
  845.           -----------------------------------------------------------------
  846.  
  847.  
  848.                RATPAY  is a separate door program that forces users to make
  849.           payments  on their  account  before they  are allowed  online. In
  850.           other words,  it's your  "collection department"! If  a User  has
  851.           borrowed  time or file transfer  credits, RATS will  set a chosen
  852.           flag, and then check to see if the user has a payment due. If the
  853.           user  has already made a payment that day, RATPAY will exit after
  854.           checking the account. If a payment  is due, the treatment of  the
  855.           user will  be determined  by the  way you  have set  the "HangUp"
  856.           parameter in RATSCFG. If  set to "Yes", the user will  be discon-
  857.           nected if they do not make their minimum payment.  Ratpay  can be
  858.           run from your TOP menu as a door.
  859.  
  860.  
  861.  
  862.  
  863.  
  864.  
  865.  
  866.  
  867.  
  868.  
  869.  
  870.  
  871.  
  872.  
  873.  
  874.  
  875.  
  876.  
  877.  
  878.  
  879.  
  880.  
  881.  
  882.  
  883.  
  884.  
  885.  
  886.  
  887.  
  888.  
  889.  
  890.  
  891.  
  892.  
  893.  
  894.  
  895.  
  896.  
  897.  
  898.  
  899.  
  900.                                           15
  901.  
  902.           -----------------------------------------------------------------
  903.                Creating Your Own ANSI Screens
  904.           -----------------------------------------------------------------
  905.  
  906.           ROBBERY.ANS   These files are optional, and if present in the
  907.           ROBBERY.ASC   RATS directory will be displayed instead of the
  908.           BUSTED.ANS    internal hard coded screens. These files can be
  909.                         found in the ROBBERY.ARJ file. If you wish to
  910.                         create your own versions of these screens, make
  911.                         sure you test them as you work on them, as the
  912.                         BUSTED.ANS is drawn OVER the ROBBERY.ANS screen.
  913.  
  914.           RATSMENU.ANS  This is the main transaction screen for RATS.
  915.           RATSMENU.ASC  This screen is FULLY configurable by you.
  916.                         This screen allows the following specific control
  917.                         codes.
  918.  
  919.                         Control Codes begin with either a Control-B or a
  920.                         Control-L as the first character.  This is then
  921.                         followed by one of the following 2 character
  922.                         identifiers:
  923.  
  924.                         Control-B then
  925.                             bm  Banked Minutes
  926.                             bk  Banked KBytes
  927.                             dm  deposited min today
  928.                             dk  deposited k today
  929.  
  930.                             wm  withdrawn min today
  931.                             wk  withdrawn k today
  932.                             tm  transfered min today
  933.                             tk  transfered k today
  934.                             kp  k purchased today
  935.  
  936.                             NB  Name Of Bank
  937.                             NO  Name Of System Operator
  938.                             NU  Name Of User
  939.                             NS  Name Of BBS System
  940.  
  941.                         Control-L  then
  942.                             md  max time deposit
  943.                             mw  max time withdraw
  944.                             mt  max time transfer
  945.  
  946.                             kd  max k deposit
  947.                             kw  max k withdraw
  948.                             kt  max k transfer
  949.  
  950.                             bt  Max Banked Time
  951.                             bk  Max Banked Kbytes
  952.  
  953.                             pk  Max Purchase K-Bytes
  954.  
  955.  
  956.  
  957.  
  958.  
  959.  
  960.                                           16
  961.  
  962.  
  963.  
  964.                         These three characters are followed by at least ONE
  965.                         character which is ignored. I have used an _ in the
  966.                         example screen. This is used to build up the correct
  967.                         field length. The FINAL character must be one of the
  968.                         following:
  969.  
  970.                           C  Center the value within the alloted length.
  971.                           R  Right Justify the value within the alloted length.
  972.                           L  Left Justify the value within the alloted length.
  973.  
  974.                         Note the field length is the length taken up by ALL of
  975.                         the above characters.
  976.  
  977.                         For example   bm______r will right justify the
  978.                         'Banked Minutes' in a field which is 10 characters
  979.                         wide.
  980.  
  981.  
  982.                         The ^bN? fields (Bank Name, BBS Name, Sysop Name, and
  983.                         User Name) will also accept the following:
  984.  
  985.                           NU_t   which will show the Users Name, the field
  986.                             length will be equal to the length of the users
  987.                             name. All trailing spaces are removed.
  988.  
  989.                         These values are displayed in the color they are drawn
  990.                         in within the RATSMENU.ANS file.  Some of these values
  991.                         do not change while RATS is running, (limits, bank
  992.                         name, user name etc) color is not a concern.
  993.  
  994.                         Since some of these values are changed and rewritten
  995.                         during the use of RATS, you must make sure that you
  996.                         make all Changeable number fields the same color, and
  997.                         define this in RATSCFG Bank Colors as the numeric
  998.                         field colors.
  999.  
  1000.  
  1001.                         The RATSMENU file may ONLY use the top 18 lines of
  1002.                         the screen, and the screen is cleared before displaying
  1003.                         this file, and since the clearscreen character
  1004.                         (control-l) is used to signify a Bank Limit Value,
  1005.                         you can NOT use ClearScreens in the RATSMenu file
  1006.                         unless it is part of the display variable codes.
  1007.  
  1008.                         Make sure you blocksave the file to the disk so it
  1009.                         does not scroll the screen up.
  1010.  
  1011.  
  1012.  
  1013.  
  1014.  
  1015.  
  1016.  
  1017.  
  1018.  
  1019.  
  1020.                                           17
  1021.  
  1022.  
  1023.  
  1024.           -----------------------------------------------------------------
  1025.                A Final Note
  1026.           -----------------------------------------------------------------
  1027.  
  1028.  
  1029.                RATS  is  just one  of the  many  fine products  marketed as
  1030.           Shareware. As a BBS operator, you  will be setting a fine example
  1031.           for your  users by registering  Shareware BBS programs  and doors
  1032.           that  you run on your  system. Please support  the Shareware con-
  1033.           cept. Thank you for trying RATS!
  1034.  
  1035.  
  1036.  
  1037.  
  1038.  
  1039.  
  1040.  
  1041.  
  1042.  
  1043.  
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061.  
  1062.  
  1063.  
  1064.  
  1065.  
  1066.  
  1067.  
  1068.  
  1069.  
  1070.  
  1071.  
  1072.  
  1073.  
  1074.  
  1075.  
  1076.  
  1077.  
  1078.  
  1079.  
  1080.                                           18
  1081.